feat: core deployment toolkit with tested RPC integration #1351

Jim8y · 2025-07-09T09:16:59Z

Summary

This PR introduces a production-ready deployment toolkit for Neo smart contracts, complete with deterministic RPC shims and exhaustive unit coverage.

Highlights

✅ DeploymentToolkit now enforces safe RPC usage, confirmation policies, and state snapshotting for manifest-driven deployments.
✅ Rich configuration surface (SetNetwork, ConfigureOptions, SetWifKey) with disposal/validation guards to prevent misuse.
✅ Helper infrastructure (QueueRpcClientFactory, StubRpcClient) enabling hermetic tests without live RPC endpoints.
✅ Expanded unit suite (39 tests, no skips) plus deterministic JSON-RPC handlers replacing formerly skipped "integration" coverage.

Example Usage

var toolkit = new DeploymentToolkit()
    .SetNetwork("testnet")
    .SetWifKey(wif)
    .ConfigureOptions(o => o.WaitForConfirmation = true);

var result = await toolkit.DeployArtifactsAsync(
    nefPath,
    manifestPath,
    initParams: new object?[] { "admin", 1 },
    waitForConfirmation: true);

Console.WriteLine($"Contract hash: {result.ContractHash}");

Testing

dotnet test tests/Neo.SmartContract.Deploy.UnitTests/Neo.SmartContract.Deploy.UnitTests.csproj
All tests green; no external RPC dependency required.

Follow-ups

Future PRs will hook this toolkit into CLI workflows and add manifest-driven batch deployment ergonomics.

neo-devpack-dotnet.sln

src/Neo.SmartContract.Deploy/Models/NetworkConfiguration.cs

src/Neo.SmartContract.Deploy/Neo.SmartContract.Deploy.csproj

vncoelho

Hi @Jim8y

My suggestion is that if this is able to Deploy and test, so, the examples we have here should be deployed during tests and we could verify states.
That would be a good test that has a real flow behind.

On the other hand, I see some separation between this repo and the framework being pushed here.

Jim8y · 2025-07-09T15:55:35Z

Hi @Jim8y

My suggestion is that if this is able to Deploy and test, so, the examples we have here should be deployed during tests and we could verify states. That would be a good test that has a real flow behind.

On the other hand, I see some separation between this repo and the framework being pushed here.

its hard to balance, smaller prs for easier to review, but lacks complete functionality, complete tookit too large for reviewing. yet if you wish to review as a whole, you can check the full pr. bellow is the deployed example contracts on testnet.

Latest Deployment (TestNet)

Contract	Address	Transaction Hash	Network
TokenContract	`0x2db2dce76b4a7f8116ecfae0d819e7099cb3a256`	`0x29397173e0e5ad93010f721ff6f786171e32e84f9bc44067072df332853e9554`	TestNet
NFTContract	`0x8699c5d074fc27cdbd7caec486387c1a29300536`	`0xc0b8c4b7dd68525da2adc39455252f32ac884947aeaba387c6ce20fa017952b7`	TestNet
GovernanceContract	`0xa3db58df3764610e43f3fda0c7b8633636c6c147`	`0x43d4a849396ddaf6b9917a3aeb30e49929a15fa32ebf51b1ab4b2d9e46dcf5a8`	TestNet

Deployment Details:

Deployer Address: NTmHjwiadq4g3VHpJ5FQigQcD4fF5m8TyX (0x0c3146e78efc42bfb7d4cc2e06e3efd063c01c56)
Network: NEO TestNet
RPC Endpoint: https://testnet1.neo.coz.io:443
Total GAS Consumed: ~30.00233163 GAS
Deployment Mode: Multi-contract with dependencies

vncoelho · 2025-07-09T15:57:45Z

I see @Jim8y, but why this needed to be here in Devpack?
Isn't this focussed on the C# compiler.

What I see in this pr is like a framework for interacting with the blockchain.

vncoelho · 2025-07-09T15:58:08Z

I see @Jim8y, but why this needed to be here in Devpack? Isn't this focussed on the C# compiler.

What I see in this pr is like a framework for interacting with the blockchain.

Maybe even the Core itself is better than here

Jim8y · 2025-07-09T15:59:57Z

I see @Jim8y, but why this needed to be here in Devpack? Isn't this focussed on the C# compiler.
What I see in this pr is like a framework for interacting with the blockchain.

Maybe even the Core itself is better than here

implementing, testing, deploying is a complete workflow, with this, developer can do everfything easily all together. they dont need to download and install and sync neo-cli, or searching for some unknown deployment methods. All of these is for a better development experience.

Jim8y · 2025-07-11T13:53:14Z

@shargon all your concern and suggestion have being resolved.

src/Neo.SmartContract.Deploy/DeploymentToolkit.cs

shargon · 2025-07-13T10:58:45Z

src/Neo.SmartContract.Deploy/Models/NetworkConfiguration.cs

+/// <summary>
+/// Wallet configuration settings
+/// </summary>
+public class WalletConfiguration


One class per file please

tests/Neo.SmartContract.Deploy.UnitTests/RpcIntegrationTests.cs

tests/Neo.SmartContract.Deploy.UnitTests/DeploymentToolkitTests.cs

src/Neo.SmartContract.Deploy/Shared/ScriptBuilderHelper.cs

examples/DeploymentArtifactsDemo/Program.cs

shargon · 2025-09-12T09:55:51Z

@Jim8y Could you solve the conflicts?

src/Neo.SmartContract.Deploy/NetworkProfile.cs

shargon · 2025-11-13T16:14:14Z

src/Neo.SmartContract.Template/templates/neodeploy/.template.config/template.json

+          "choice": "3.8.1-*"
+        }
+      ],
+      "defaultValue": "3.8.1-*",


Suggested change

"choice": "3.8.1-*"

}

],

"defaultValue": "3.8.1-*",

"choice": "3.*"

}

],

"defaultValue": "3.*",

shargon · 2025-11-13T16:27:56Z

Move to master first

ajara87 · 2025-11-13T22:17:46Z

src/Neo.SmartContract.Deploy/DeploymentOptions.cs

+    public DeploymentOptions Clone() => new()
+        {
+            Network = Network,
+            WaitForConfirmation = WaitForConfirmation,
+            ConfirmationRetries = ConfirmationRetries,
+            ConfirmationDelaySeconds = ConfirmationDelaySeconds,
+            SignerProvider = SignerProvider,
+            TransactionSignerAsync = TransactionSignerAsync
+        };


Suggested change

public DeploymentOptions Clone() => new()

{

Network = Network,

WaitForConfirmation = WaitForConfirmation,

ConfirmationRetries = ConfirmationRetries,

ConfirmationDelaySeconds = ConfirmationDelaySeconds,

SignerProvider = SignerProvider,

TransactionSignerAsync = TransactionSignerAsync

};

public DeploymentOptions Clone() => new()

{

Network = Network,

WaitForConfirmation = WaitForConfirmation,

ConfirmationRetries = ConfirmationRetries,

ConfirmationDelaySeconds = ConfirmationDelaySeconds,

SignerProvider = SignerProvider,

TransactionSignerAsync = TransactionSignerAsync

};

tests fail due to whitespaces

- Add DeploymentToolkit class with basic deployment API - Implement network configuration support (mainnet, testnet, local, custom RPC) - Add WIF key support for transaction signing - Create comprehensive project structure with interfaces and models - Add configuration management with JSON and environment variable support - Include 16 unit tests covering all basic functionality - Update README.md with deployment documentation and usage examples This establishes the foundation for Neo smart contract deployment capabilities without implementation details, providing a clean base for future enhancements.

…rence - Fix whitespace formatting issues in deployment toolkit files - Add missing final newlines to all source files - Remove duplicate Microsoft.NET.Test.Sdk package reference in test project - All 16 unit tests continue to pass - Code formatting now passes GitHub Actions checks

- Remove Network property from NetworkConfiguration as it depends on RpcUrl - Change NetworkMagic to nullable and retrieve from RPC when not configured - Add logic to fetch NetworkMagic from RPC using GetVersionAsync() - Remove unnecessary Compile Update section from csproj file - Update unit tests to match new behavior

- Add tests to verify network magic can be retrieved from RPC - Add tests for network configuration priority (specific > global > RPC) - Add tests for SetNetwork with various inputs and edge cases - Add tests to ensure proper RPC URL configuration for known networks - Document expected network magic values for mainnet and testnet

- Change testnet RPC URL from testnet1.neo.coz.io to testnet.rpc.ngd.network - Update all test assertions to use the new NGD testnet URL - Add integration tests to verify RPC connectivity (skipped by default) - Ensure network magic retrieval works with NGD testnet endpoint

Co-authored-by: Shargon <[email protected]>

* Unify numeric system call handlers * Restore legacy numeric clamp/copySign behaviour * refactor: enforce numeric system call registration requirements --------- Co-authored-by: Alvaro <[email protected]>

* Add analyzer enforcement for NEP standard interfaces * Fix nullable guards in NEP standard codefix

- README: document new signer hooks and standardise init param example - DeploymentArtifactsRequest.cs: add signer + custom transaction signer hooks - DeploymentOptions.cs: add signer provider, transaction signer plumbing

* Docs/Test: restructure C# syntax checklists and probes * Docs: clarify checklist wording * Docs: reference official C# what's-new pages * Cleanup: drop python helper scripts

* Update to net 10 * LF * update actions * update neo-vm * fix * LF * remove globals * Remove NeoVM package * LF * fix ut * use spaces

* Optimize syntax probe execution * Update tests/Neo.Compiler.CSharp.UnitTests/SyntaxProbes/Helper.cs Co-authored-by: Shargon <[email protected]> * Fix * use lock --------- Co-authored-by: Shargon <[email protected]>

* Fix INITSLOT parameter count for generic methods * Add regression tests for InitSlot generic handling * Fix SupportedStandards analyzer enum parsing

* Clarify LINQ guidance and update analyzer * Clarify LINQ guidance and stabilize tests

* Add support for key C# 14 syntax * Limit CI workflows to 20 minute timeout * Apply suggestions from code review * Apply suggestions from code review --------- Co-authored-by: Shargon <[email protected]>

Jim8y mentioned this pull request Jul 9, 2025

feat: implement full Neo smart contract deployment functionality #1352

Closed

Jim8y force-pushed the pr1-core-deployment-framework branch 2 times, most recently from ce28e18 to ef94799 Compare July 9, 2025 11:06

shargon reviewed Jul 9, 2025

View reviewed changes

vncoelho reviewed Jul 9, 2025

View reviewed changes

shargon reviewed Jul 13, 2025

View reviewed changes

superboyiii mentioned this pull request Jul 24, 2025

v3.9.0 Checklist neo-project/neo#4091

Open

ajara87 requested changes Sep 10, 2025

View reviewed changes

examples/DeploymentArtifactsDemo/Program.cs Outdated Show resolved Hide resolved

ajara87 requested changes Sep 10, 2025

View reviewed changes

examples/DeploymentArtifactsDemo/Program.cs Outdated Show resolved Hide resolved

ajara87 requested changes Sep 10, 2025

View reviewed changes

examples/DeploymentArtifactsDemo/Program.cs Outdated Show resolved Hide resolved

shargon changed the base branch from master to dev September 12, 2025 09:44

Jim8y changed the title ~~feat: add core Neo smart contract deployment framework~~ feat: core deployment toolkit with tested RPC integration Oct 24, 2025

shargon requested a review from ajara87 October 27, 2025 20:50

shargon reviewed Oct 28, 2025

View reviewed changes

src/Neo.SmartContract.Deploy/NetworkProfile.cs Outdated Show resolved Hide resolved

shargon reviewed Nov 13, 2025

View reviewed changes

ajara87 requested changes Nov 13, 2025

View reviewed changes

Jim8y added 7 commits November 14, 2025 06:52

chore: update neo submodule to latest commit

65765b5

fix: resolve code formatting issues

97e9eed

Jim8y and others added 27 commits November 14, 2025 07:32

Support out parameters for static and instance fields (#1408)

e86a670

Co-authored-by: Shargon <[email protected]>

Refine deployment toolkit RPC handling

c5d2686

Unify numeric system call handlers (#1410)

f1920b2

* Unify numeric system call handlers * Restore legacy numeric clamp/copySign behaviour * refactor: enforce numeric system call registration requirements --------- Co-authored-by: Alvaro <[email protected]>

refactor: improve compiler exception diagnostics (#1412)

ff51c01

Add analyzer enforcement for NEP interface compliance (#1413)

0c5bbf8

* Add analyzer enforcement for NEP standard interfaces * Fix nullable guards in NEP standard codefix

Enhance string Split and Trim system call support (#1414)

d574df4

Update submodule (#1417)

b874e7a

Document record handling and expand coverage (#1419)

7d0b1d5

Throttle network magic retries and expand coverage

ed1472f

Extend deployment request/options APIs and docs

2f1ee61

- README: document new signer hooks and standardise init param example - DeploymentArtifactsRequest.cs: add signer + custom transaction signer hooks - DeploymentOptions.cs: add signer provider, transaction signer plumbing

Docs/Test: restructure C# syntax checklists and probes (#1420)

b8f7903

* Docs/Test: restructure C# syntax checklists and probes * Docs: clarify checklist wording * Docs: reference official C# what's-new pages * Cleanup: drop python helper scripts

Update to net 10 (#1421)

f78ce6e

* Update to net 10 * LF * update actions * update neo-vm * fix * LF * remove globals * Remove NeoVM package * LF * fix ut * use spaces

Optimize syntax probe execution (#1422)

d89ca33

* Optimize syntax probe execution * Update tests/Neo.Compiler.CSharp.UnitTests/SyntaxProbes/Helper.cs Co-authored-by: Shargon <[email protected]> * Fix * use lock --------- Co-authored-by: Shargon <[email protected]>

Fix INITSLOT parameter count for generic methods (#1423)

c7f9b0a

* Fix INITSLOT parameter count for generic methods * Add regression tests for InitSlot generic handling * Fix SupportedStandards analyzer enum parsing

Add StringBuilder runtime support and analyzer (#1425)

37e881a

Add multi-dimensional array support (#1424)

8b1a983

feat(deploy): add deployment template and toolkit improvements

7945bb3

Clarify LINQ usage guidance (#1428)

522796c

* Clarify LINQ guidance and update analyzer * Clarify LINQ guidance and stabilize tests

Fix deployment toolkit signer/order handling and CLI args

c49f50d

Fix LINQ artifact after net10 temp project bump

29cb741

Add C# 14 syntax feature support (#1429)

472d4ba

* Add support for key C# 14 syntax * Limit CI workflows to 20 minute timeout * Apply suggestions from code review * Apply suggestions from code review --------- Co-authored-by: Shargon <[email protected]>

Harden deployment toolkit

e19835d

Restore known network magic defaults and configuration overrides

f10d351

Support per-network WIF configuration

2f11fc7

Clean code

0db1e86

Add deploy project scaffolding to nccs

e08c55c

Fix RpcStore OnNewSnapshot duplication

cd3f43e

Jim8y force-pushed the pr1-core-deployment-framework branch from f32cf76 to cd3f43e Compare November 14, 2025 00:42

Jim8y changed the base branch from dev to master November 14, 2025 00:45

Merge branch 'master' into pr1-core-deployment-framework

e1cc15f

feat: core deployment toolkit with tested RPC integration #1351

Are you sure you want to change the base?

feat: core deployment toolkit with tested RPC integration #1351

Conversation

Jim8y commented Jul 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Highlights

Example Usage

Testing

Follow-ups

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

vncoelho left a comment

Choose a reason for hiding this comment

Uh oh!

Jim8y commented Jul 9, 2025

Latest Deployment (TestNet)

Uh oh!

vncoelho commented Jul 9, 2025

Uh oh!

vncoelho commented Jul 9, 2025

Uh oh!

Jim8y commented Jul 9, 2025

Uh oh!

Jim8y commented Jul 11, 2025

Uh oh!

Uh oh!

shargon Jul 13, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shargon commented Sep 12, 2025

Uh oh!

Uh oh!

shargon Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

shargon commented Nov 13, 2025

Uh oh!

ajara87 Nov 13, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Jim8y commented Jul 9, 2025 •

edited

Loading